Skip to main content
GET
/
users
Get all users
curl --request GET \
  --url https://your_a2_service/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "budget": 123,
    "campaign_count": 1,
    "creative_count": 1,
    "credit": 123,
    "email": "[email protected]",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true,
    "is_superuser": true,
    "is_verified": true,
    "permissions": {},
    "placement_count": 1,
    "preferences": {
      "etc": {},
      "notification_methods": {},
      "notification_methods_data": {},
      "notifications": {}
    },
    "role": "advertiser",
    "name": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
id
string | null
​
role
enum<string> | null

User role enum.

Available options:
advertiser,
retailer,
admin

Response

Successful Response

​
budget
number
required

The total budget currently available to the user.

​
campaign_count
integer
required

The number of campaigns owned by the user.

Required range: x >= 0
​
creative_count
integer
required

The number of creatives owned by the user.

Required range: x >= 0
​
credit
number
required

The total credit currently available to the user.

​
email
string<email>
required

The email of the user.

​
id
string<uuid>
required

The id of the user.

​
is_active
boolean
required

Is the user active.

​
is_superuser
boolean
required

Is the user admin.

​
is_verified
boolean
required

Is the user email is verified.

​
permissions
Permissions · object
required

The permissions information of the user.

​
placement_count
integer
required

The number of placements owned by the user.

Required range: x >= 0
​
preferences
UserPreferences · object
required

Represents a user preferences.

​
role
enum<string>
required

User role enum.

Available options:
advertiser,
retailer,
admin
​
name
string | null

The name of the user.